<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxPerimeterFunction</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.51 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CInterface"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxPerimeterFunction"></a>mxPerimeterFunction</h1><div class=CBody><p>Defines the requirements for a perimeter function.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxPerimeterFunction" >mxPerimeterFunction</a></td><td class=SDescription>Defines the requirements for a perimeter function.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxPerimeterFunction.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxPerimeterFunction.apply" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">apply</a></td><td class=SDescription>Implements a perimeter function.</td></tr><tr class="SClass"><td class=SEntry><a href="#mxRectanglePerimeter" >mxRectanglePerimeter</a></td><td class=SDescription>Implements a rectangular perimeter for the given bounds.</td></tr><tr class="SClass"><td class=SEntry><a href="#mxEllipsePerimeter" >mxEllipsePerimeter</a></td><td class=SDescription>Implements an elliptic perimeter. </td></tr><tr class="SClass"><td class=SEntry><a href="#mxRhombusPerimeter" >mxRhombusPerimeter</a></td><td class=SDescription>Implements a rhombus (aka diamond) perimeter. </td></tr><tr class="SClass"><td class=SEntry><a href="#mxTrianglePerimeter" >mxTrianglePerimeter</a></td><td class=SDescription>Implements a triangle perimeter. </td></tr><tr class="SClass"><td class=SEntry><a href="#mxPerimeter" >mxPerimeter</a></td><td class=SDescription>Provides various perimeter functions to be used in a style as the value of <a href="../util/mxConstants-php.html#mxConstants.STYLE_PERIMETER" class=LVariable id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxConstants.STYLE_PERIMETER</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxPerimeter.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxPerimeter.RectanglePerimeter" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">RectanglePerimeter</a></td><td class=SDescription>Provides a rectangular perimeter.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxPerimeter.EllipsePerimeter" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">EllipsePerimeter</a></td><td class=SDescription>Provides an elliptic perimeter.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxPerimeter.RhombusPerimeter" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">RhombusPerimeter</a></td><td class=SDescription>Provides a rhombus (aka diamond) perimeter.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxPerimeter.TrianglePerimeter" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">TrianglePerimeter</a></td><td class=SDescription>Provides a triangle perimeter. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxPerimeterFunction.Functions"></a>Functions</h3></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPerimeterFunction.apply"></a>apply</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>public function apply(</td><td class="PParameter  prettyprint " nowrap>$bounds,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>$vertex,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>$next,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>$orthogonal</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Implements a perimeter function.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>bounds</td><td class=CDLDescription><a href="../util/mxRectangle-php.html#mxRectangle" class=LClass id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">mxRectangle</a> that represents the absolute bounds of the vertex.</td></tr><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">mxCellState</a> that represents the vertex.</td></tr><tr><td class=CDLEntry>next</td><td class=CDLDescription><a href="../util/mxPoint-php.html#mxPoint" class=LClass id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">mxPoint</a> that represents the nearest neighbour point on the given edge.</td></tr><tr><td class=CDLEntry>orthogonal</td><td class=CDLDescription>Boolean that specifies if the orthogonal projection onto the perimeter should be returned.&nbsp; If this is false then the intersection of the perimeter and the line between the next and the center point is returned.</td></tr></table></div></div></div>

<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="mxRectanglePerimeter"></a>mxRectanglePerimeter</h2><div class=CBody><p>Implements a rectangular perimeter for the given bounds.</p></div></div></div>

<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="mxEllipsePerimeter"></a>mxEllipsePerimeter</h2><div class=CBody><p>Implements an elliptic perimeter.&nbsp; See &lt;RectanglePerimeter&gt; for a description of the parameters.</p></div></div></div>

<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="mxRhombusPerimeter"></a>mxRhombusPerimeter</h2><div class=CBody><p>Implements a rhombus (aka diamond) perimeter.&nbsp; See &lt;RectanglePerimeter&gt; for a description of the parameters.</p></div></div></div>

<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="mxTrianglePerimeter"></a>mxTrianglePerimeter</h2><div class=CBody><p>Implements a triangle perimeter.&nbsp; See &lt;RectanglePerimeter&gt; for a description of the parameters.</p></div></div></div>

<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="mxPerimeter"></a>mxPerimeter</h2><div class=CBody><p>Provides various perimeter functions to be used in a style as the value of <a href="../util/mxConstants-php.html#mxConstants.STYLE_PERIMETER" class=LVariable id=link14 onMouseOver="ShowTip(event, 'tt2', 'link14')" onMouseOut="HideTip('tt2')">mxConstants.STYLE_PERIMETER</a>.</p><p>The parameters are explained in <a href="#mxPerimeter.RectanglePerimeter" class=LVariable id=link15 onMouseOver="ShowTip(event, 'tt3', 'link15')" onMouseOut="HideTip('tt3')">RectanglePerimeter</a>.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#mxPerimeter.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#mxPerimeter.RectanglePerimeter" id=link10 onMouseOver="ShowTip(event, 'tt3', 'link10')" onMouseOut="HideTip('tt3')">RectanglePerimeter</a></td><td class=SDescription>Provides a rectangular perimeter.</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#mxPerimeter.EllipsePerimeter" id=link11 onMouseOver="ShowTip(event, 'tt4', 'link11')" onMouseOut="HideTip('tt4')">EllipsePerimeter</a></td><td class=SDescription>Provides an elliptic perimeter.</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#mxPerimeter.RhombusPerimeter" id=link12 onMouseOver="ShowTip(event, 'tt5', 'link12')" onMouseOut="HideTip('tt5')">RhombusPerimeter</a></td><td class=SDescription>Provides a rhombus (aka diamond) perimeter.</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#mxPerimeter.TrianglePerimeter" id=link13 onMouseOver="ShowTip(event, 'tt6', 'link13')" onMouseOut="HideTip('tt6')">TrianglePerimeter</a></td><td class=SDescription>Provides a triangle perimeter. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxPerimeter.Variables"></a>Variables</h3></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPerimeter.RectanglePerimeter"></a>RectanglePerimeter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $RectanglePerimeter</td></tr></table></blockquote><p>Provides a rectangular perimeter.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPerimeter.EllipsePerimeter"></a>EllipsePerimeter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $EllipsePerimeter</td></tr></table></blockquote><p>Provides an elliptic perimeter.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPerimeter.RhombusPerimeter"></a>RhombusPerimeter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $RhombusPerimeter</td></tr></table></blockquote><p>Provides a rhombus (aka diamond) perimeter.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPerimeter.TrianglePerimeter"></a>TrianglePerimeter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $TrianglePerimeter</td></tr></table></blockquote><p>Provides a triangle perimeter.&nbsp; See <a href="#mxPerimeter.RectanglePerimeter" class=LVariable id=link16 onMouseOver="ShowTip(event, 'tt3', 'link16')" onMouseOut="HideTip('tt3')">RectanglePerimeter</a> for a description of the parameters.</p></div></div></div>

</div><!--Content-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MFile><a href="../canvas/mxGdCanvas-php.html">canvas/<wbr>mxGdCanvas.php</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Io</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-php.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-php.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-php.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-php.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-php.html">mxObjectCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxStylesheetCodec-php.html">mxStylesheetCodec</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Model</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../model/mxCell-php.html">mxCell</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxCellPath-php.html">mxCellPath</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxGeometry-php.html">mxGeometry</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxGraphModel-php.html">mxGraphModel</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../reader/mxGraphViewHtmlReader-php.html">mxGraphViewHtmlReader</a></div></div><div class=MEntry><div class=MFile><a href="../reader/mxGraphViewImageReader-php.html">mxGraphViewImageReader</a></div></div><div class=MEntry><div class=MFile><a href="../canvas/mxHtmlCanvas-php.html">mxHtmlCanvas</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Util</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../util/mxConstants-php.html">mxConstants</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEvent-php.html">mxEvent</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEventObject-php.html">mxEventObject</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEventSource-php.html">mxEventSource</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxImageBundle-php.html">mxImageBundle</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxLog-php.html">mxLog</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxPoint-php.html">mxPoint</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxRectangle-php.html">mxRectangle</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxUtils-php.html">mxUtils</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">View</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="mxCellState-php.html">mxCellState</a></div></div><div class=MEntry><div class=MFile><a href="mxConnectionConstraint-php.html">mxConnectionConstraint</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeStyle-php.html">mxEdgeStyleFunction</a></div></div><div class=MEntry><div class=MFile><a href="mxGraph-php.html">mxGraph</a></div></div><div class=MEntry><div class=MFile><a href="mxGraphView-php.html">mxGraphView</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxPerimeterFunction</div></div><div class=MEntry><div class=MFile><a href="mxStyleRegistry-php.html">mxStyleRegistry</a></div></div><div class=MEntry><div class=MFile><a href="mxStylesheet-php.html">mxStylesheet</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Index</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MIndex><a href="../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Interfaces.html">Interfaces</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Variables.html">Variables</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Interfaces">Interfaces</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([4, 5], 6);// --></script></div><!--Menu-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>public function apply(</td><td class="PParameter  prettyprint " nowrap>$bounds,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>$vertex,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>$next,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>$orthogonal</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Implements a perimeter function.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $STYLE_PERIMETER</td></tr></table></blockquote>Defines the key for the perimeter style. </div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $RectanglePerimeter</td></tr></table></blockquote>Provides a rectangular perimeter.</div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $EllipsePerimeter</td></tr></table></blockquote>Provides an elliptic perimeter.</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $RhombusPerimeter</td></tr></table></blockquote>Provides a rhombus (aka diamond) perimeter.</div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">public static $TrianglePerimeter</td></tr></table></blockquote>Provides a triangle perimeter. </div></div><div class=CToolTip id="tt7"><div class=CClass>Implements a 2-dimensional rectangle with double precision coordinates.</div></div><div class=CToolTip id="tt8"><div class=CClass>Represents the current state of a cell in a given mxGraphView.</div></div><div class=CToolTip id="tt9"><div class=CClass>Implements a 2-dimensional point with double precision coordinates.</div></div><!--END_ND_TOOLTIPS-->




<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>